Skip to main content
POST
/
v1
/
prompt-tools
Create Prompt Tool
curl --request POST \
  --url https://api.getmaxim.ai/v1/prompt-tools \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '
{
  "workspaceId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "type": "PROGRAM",
  "folderId": "<string>",
  "config": {
    "args": "<string>",
    "code": "<string>",
    "schema": {
      "type": "function",
      "function": {
        "name": "<string>",
        "description": "<string>",
        "parameters": {}
      }
    },
    "lang": "javascript",
    "scripts": "<string>",
    "sample": "<string>"
  }
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "type": "<string>",
    "workspaceId": "<string>",
    "accountId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "config": "<unknown>",
    "folderId": "<string>",
    "fromMcpServer": "<string>"
  }
}

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Body

application/json
workspaceId
string
required

Unique identifier for the workspace

name
string
required

Name of the prompt tool

description
string
required

Description of the prompt tool

type
enum<string>
required

Type of the prompt tool

Available options:
PROGRAM,
API,
SCHEMA
folderId
string | null

Folder ID where the prompt tool is located

config
Program · object

Configuration for the prompt tool

Response

Prompt tool created successfully

data
object
required